/*
Copyright (c) 2009, Young Digital Planet SA
All rights reserved.

* Redistribution and use in source and binary forms, with or without 
  modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this 
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, 
  this list of conditions and the following disclaimer in the documentation 
  and/or other materials provided with the distribution.
* Neither the name of the Young Digital Planet SA nor the names of its 
  contributors may be used to endorse or promote products derived from this 
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
package com.yauthor.module
{
	/**
	 * Contains information about activity check operation.
	 * @see com.yauthor.module.IActivity#check()
	 */	
	public interface IResult
	{
		/**
		 * Activity awaits for evaluation.
		 */
		function get evaluationPending():Boolean;
		/**
		 * How many elements user should do. <br> 
		 * WARNING: done + errors can be different than todo
		 */
		function get todo():uint;
		/**
		 * How many activity elements were done correctly. Elements
		 * that were not touched by counted as done nor as errors. 
		 */
		function get done():uint;
		/**
		 * How many activity elements were done incorrectly. Elements
		 * that were not touched by counted as done nor as errors. 
		 */
		function get errors():uint;
		/**
		 * A number of errors that will be substracted from the result. Not all
		 * errors may take part in result counting - it is configured externally.  
		 */
		function get errorsInResult():uint;
		/**
		 * The percentage result calculated on todo/done/errors. The result is rounded
		 * downwards (floor) to whole numbers.
		 * @return percentage result or Number.POSITIVE_INFINITY if there is nothing todo
		 * in this result
		 */
		function get result():Number;
		/**
		 * Check if this result is equal to some other result.
		 * @param r other result
		 * @return true if results are equal
		 */
		function equals( r:IResult ):Boolean;
	}
}